🚀[Feature]: Test Setup & Teardown Support for GitHub Actions Workflows #191

MariusStorhaug · 2025-10-01T16:02:17Z

Overview

This release introduces automated test environment management through BeforeAll.ps1 and AfterAll.ps1 scripts, enabling comprehensive setup and teardown capabilities for module tests running in GitHub Actions. This enhancement solves the challenge of managing complex test environments (databases, infrastructure, external services) across parallel test matrices while ensuring proper cleanup regardless of test outcomes.

Fixes 🚀[Feature]: Add support for running setup and teardown scripts during tests #169

🎯 Main Feature: Test Lifecycle Management

The Problem

Previously, setting up test infrastructure required:

Rate-limiting issue when creating GitHub Repositories for the GitHub PowerShell module, where the setup and teardown happens in the individual test files via BeforeAll and AfterAll blocks.

The Solution

Dedicated setup and teardown jobs with automatic script execution:

BeforeAll: Runs once before all test matrix jobs begin.
AfterAll: Runs once after all test matrix jobs complete.

Configuration

No configuration needed! Simply add scripts to your test directory.
The workflow automatically detects and executes these scripts when present.

your-module/
├── tests/
│   ├── BeforeAll.ps1      ← Setup script (optional)
│   ├── AfterAll.ps1       ← Teardown script (optional)
│   └── Module.Tests.ps1   ← The tests that require external setup
│

Additional: Specification-Driven Development Framework

This release also includes an implementation of spec-kit principles, adding a structured workflow for feature development from specification through implementation.

What's Included

Prompt templates (.github/prompts/) for /specify, /clarify, /plan, /tasks, /analyze, /implement commands
Project constitution (.specify/memory/constitution.md) defining architectural principles:

Additional Workflow Improvements

Linter Configuration Updates

Added VALIDATE_BIOME_FORMAT: false for Biome formatter
Added VALIDATE_GITHUB_ACTIONS_ZIZMOR: false for workflow security scanning
Added VALIDATE_JSCPD: false for copy-paste detection
Consistent linting configuration across Build-Docs and Linter workflows

Test Workflow Enhancements

Environment variables properly scoped at workflow level
Clearer parameter naming (OSName vs OS)
Improved test execution coordination

Documentation

Comprehensive setup/teardown guide in README.md
Inline documentation in all prompt templates and scripts
Usage examples for common test scenarios

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

…tation Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

…tecture Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

…e detection logic Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

…g workflows Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

- Implemented `setup-plan.ps1` to create an implementation plan for features, including JSON output option and template handling. - Developed `update-agent-context.ps1` to update agent context files based on `plan.md`, supporting multiple agent types and ensuring environment validation. - Created templates for agent files and implementation plans to standardize documentation and facilitate easier updates. - Introduced a comprehensive feature specification template to guide feature development and ensure clarity in requirements. - Added a task template to streamline task generation for feature implementation, ensuring proper sequencing and dependencies.

…nce and requirements

…omated publishing process

…manage BeforeAll/AfterAll test scripts

- Introduced quickstart.md for validating setup-test composite action functionality. - Included prerequisites, integration steps, validation checklist, and test scenarios. - Documented expected outcomes and debug commands for ease of use. --- feat: Document research findings for local GitHub composite action - Created research.md consolidating decisions on composite action structure, error handling, and integration patterns. - Outlined rationale for using a single action with mode parameter for BeforeAll and AfterAll scripts. - Provided implementation guidance and technical decisions summary. --- feat: Define tasks for implementing local GitHub composite action - Established tasks.md outlining execution flow, task dependencies, and phases for implementation. - Specified tasks for setup, testing, core implementation, integration, and polish. - Included validation checklist to ensure all requirements are met before execution.

… external resource management

…intended use and provide examples for managing external test resources

Copilot

Pull Request Overview

This pull request introduces test setup and teardown capability for PowerShell modules through a comprehensive enhancement to the Process-PSModule framework. The main purpose is to enable test infrastructure setup and cleanup scripts that can run before and after test matrix jobs across all platforms.

Key changes include:

Addition of BeforeAll.ps1 and AfterAll.ps1 test scripts that execute automatically during test workflows
Enhanced Test-ModuleLocal.yml workflow with dedicated setup and teardown jobs
Complete feature specification and implementation plan with contracts and documentation
Updated README with comprehensive documentation of the new test setup capabilities

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
tests/srcWithManifestTestRepo/tests/MyTests/BeforeAll.ps1	Example BeforeAll setup script for MyTests directory
tests/srcWithManifestTestRepo/tests/MyTests/AfterAll.ps1	Example AfterAll teardown script for MyTests directory
tests/srcWithManifestTestRepo/tests/Environments/BeforeAll.ps1	Example BeforeAll setup script for Environments directory
tests/srcWithManifestTestRepo/tests/Environments/AfterAll.ps1	Example AfterAll teardown script for Environments directory
tests/srcTestRepo/tests/BeforeAll.ps1	Main BeforeAll setup script with comprehensive setup tasks
tests/srcTestRepo/tests/AfterAll.ps1	Main AfterAll teardown script with comprehensive cleanup tasks
.github/workflows/Test-ModuleLocal.yml	Enhanced workflow with BeforeAll-ModuleLocal and AfterAll-ModuleLocal jobs
.github/workflows/workflow.yml	Updated to pass ModuleTestSuites instead of matrix parameters
.github/workflows/CI.yml	Updated to pass ModuleTestSuites instead of matrix parameters
README.md	Added comprehensive documentation for setup and teardown scripts
specs/001-building-on-this/*	Complete feature specification and implementation artifacts

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/srcWithManifestTestRepo/tests/MyTests/BeforeAll.ps1

tests/srcWithManifestTestRepo/tests/MyTests/AfterAll.ps1

tests/srcWithManifestTestRepo/tests/BeforeAll.ps1

tests/srcWithManifestTestRepo/tests/AfterAll.ps1

tests/srcTestRepo/tests/BeforeAll.ps1

tests/srcTestRepo/tests/AfterAll.ps1

…MyTests scripts

Copilot

Pull Request Overview

Copilot reviewed 35 out of 35 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

.github/workflows/Test-ModuleLocal.yml

…for consistency

Copilot

Pull Request Overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

tests/srcWithManifestTestRepo/tests/BeforeAll.ps1:1

The final message says 'AFTERALL SETUP SCRIPT' but should say 'BEFOREALL SETUP SCRIPT' to match the script's purpose.

Write-Host "=== BEFOREALL SETUP SCRIPT (Environments) EXECUTING ==="

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

specs/001-building-on-this/tasks.md

…n up the media directory.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull Request Overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

.github/workflows/Test-ModuleLocal.yml

… removing redundant directory search logic

… workflows

…ocess-PSModule into 001-building-on-this

.github/workflows/CI.yml

.github/workflows/workflow.yml

Copilot

Pull Request Overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 4 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

.github/workflows/workflow.yml

.github/workflows/Test-ModuleLocal.yml

.github/workflows/workflow.yml

…tency

…values for improved flexibility

… for consistency

Copilot

Pull Request Overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 4 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

.github/workflows/workflow.yml

.github/workflows/CI.yml

…ub composite action for BeforeAll/AfterAll test scripts as part of project restructuring. This includes the deletion of research.md, spec.md, and tasks.md files, consolidating the documentation and streamlining the development process.

…eAll and AfterAll scripts for cleaner execution flow

Copilot

Pull Request Overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot AI and others added 21 commits July 4, 2025 13:32

Initial plan

0aa2dfc

Add BeforeAll and AfterAll job support for Test-ModuleLocal workflows

4d3f4ff

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Add additional test BeforeAll/AfterAll scripts for comprehensive testing

9eeb8c7

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Add documentation for BeforeAll/AfterAll setup and teardown scripts

2a30035

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Rework BeforeAll/AfterAll to use PowerShell-based steps

2027a0b

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Update documentation for PowerShell-based BeforeAll/AfterAll implemen…

92d0958

…tation Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Merge branch 'main' into copilot/fix-169

fdfea9e

Implement separate BeforeAll/AfterAll jobs with conditional execution

7b69fe7

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Update documentation to reflect separate BeforeAll/AfterAll job archi…

87ac2eb

…tecture Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Move BeforeAll/AfterAll jobs into Test-ModuleLocal workflow and remov…

f6fef54

…e detection logic Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

Move matrix strategy into Test-ModuleLocal workflow and update callin…

3e25e4c

…g workflows Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>

feat: Update constitution and implementation plan with expanded guida…

c9151a8

…nce and requirements

chore: Update constitution version reference in plan template to v1.1.2

849ff31

chore: Update plan template to reference Constitution v1.3.0

bfee666

feat: Update constitution to reflect new repository structure and aut…

e5077eb

…omated publishing process

feat: Add feature specification for local GitHub composite action to …

205fb8b

…manage BeforeAll/AfterAll test scripts

feat: Enhance documentation for BeforeAll/AfterAll scripts to clarify…

f02098b

… external resource management

feat: Update documentation for BeforeAll/AfterAll scripts to clarify …

7e67478

…intended use and provide examples for managing external test resources

feat: Enhance BeforeAll/AfterAll documentation and update task numbering

5bb6eee

MariusStorhaug requested a review from a team as a code owner October 1, 2025 16:02

Copilot AI review requested due to automatic review settings October 1, 2025 16:02

Copilot AI reviewed Oct 1, 2025

View reviewed changes

MariusStorhaug added 2 commits October 1, 2025 18:40

feat: Add BeforeAll and AfterAll scripts for Environments and remove …

97d7a9f

…MyTests scripts

Dedub envs

bbdf695

Copilot AI review requested due to automatic review settings October 1, 2025 17:17

Copilot AI reviewed Oct 1, 2025

View reviewed changes

github-advanced-security bot found potential problems Oct 1, 2025

View reviewed changes

.github/workflows/Test-ModuleLocal.yml Fixed Show fixed Hide fixed

.github/workflows/Test-ModuleLocal.yml Fixed Show fixed Hide fixed

Fix linter

1e6248b

MariusStorhaug added 2 commits October 1, 2025 22:02

fix: Correct capitalization of 'GitHub' in documentation for consistency

d8da82d

fix: Correct capitalization of 'API' in execution flow documentation …

4e957db

…for consistency

Copilot AI review requested due to automatic review settings October 1, 2025 20:33

Copilot AI reviewed Oct 1, 2025

View reviewed changes

specs/001-building-on-this/tasks.md Outdated Show resolved Hide resolved

MariusStorhaug and others added 2 commits October 1, 2025 22:47

Remove backup and original Draw.io files for the flow diagram to clea…

879e315

…n up the media directory.

Update tests/srcWithManifestTestRepo/tests/BeforeAll.ps1

f938d45

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings October 1, 2025 21:02

Copilot AI reviewed Oct 1, 2025

View reviewed changes

.github/workflows/Test-ModuleLocal.yml Outdated Show resolved Hide resolved

.github/workflows/Test-ModuleLocal.yml Outdated Show resolved Hide resolved

.github/workflows/Test-ModuleLocal.yml Outdated Show resolved Hide resolved

MariusStorhaug added 3 commits October 1, 2025 23:12

fix: Simplify BeforeAll and AfterAll script execution in workflows by…

4ef34b4

… removing redundant directory search logic

feat: Add BeforeAll and AfterAll steps for module local testing in CI…

b9ffbd7

… workflows

Merge branch '001-building-on-this' of https://github.com/PSModule/Pr…

764667a

…ocess-PSModule into 001-building-on-this

github-advanced-security bot found potential problems Oct 1, 2025

View reviewed changes

fix: Restore TestName input in CI workflows for consistency

552793f

Copilot AI review requested due to automatic review settings October 1, 2025 21:25

Copilot AI reviewed Oct 1, 2025

View reviewed changes

.github/workflows/workflow.yml Show resolved Hide resolved

.github/workflows/workflow.yml Show resolved Hide resolved

.github/workflows/Test-ModuleLocal.yml Show resolved Hide resolved

.github/workflows/workflow.yml Show resolved Hide resolved

MariusStorhaug added 2 commits October 1, 2025 23:27

fix: Swap TestName and Name inputs in workflow for clarity and consis…

6e7132e

…tency

fix: Update TestPath and TestName inputs to be optional with default …

07457de

…values for improved flexibility

Copilot AI review requested due to automatic review settings October 1, 2025 21:29

fix: Update job name in Test-ModuleLocal workflow to use RunsOn input…

3c6e9b3

… for consistency

Copilot AI reviewed Oct 1, 2025

View reviewed changes

.github/workflows/workflow.yml Show resolved Hide resolved

.github/workflows/workflow.yml Show resolved Hide resolved

.github/workflows/CI.yml Show resolved Hide resolved

.github/workflows/CI.yml Show resolved Hide resolved

MariusStorhaug added the Minor label Oct 1, 2025

MariusStorhaug changed the title ~~Add test setup and teardown capability~~ 🚀[Feature]: Add setup and teardown capability for tests Oct 1, 2025

MariusStorhaug added 2 commits October 1, 2025 23:41

fix: Remove unnecessary Push-Location and Pop-Location calls in Befor…

48dd4d5

…eAll and AfterAll scripts for cleaner execution flow

Copilot AI review requested due to automatic review settings October 1, 2025 21:45

Copilot AI reviewed Oct 1, 2025

View reviewed changes

MariusStorhaug changed the title ~~🚀[Feature]: Add setup and teardown capability for tests~~ 🚀[Feature]: Test Setup & Teardown Support for GitHub Actions Workflows Oct 1, 2025

MariusStorhaug self-assigned this Oct 1, 2025

MariusStorhaug merged commit 7e38e21 into main Oct 1, 2025
110 of 112 checks passed

MariusStorhaug deleted the 001-building-on-this branch October 1, 2025 22:19

🚀[Feature]: Test Setup & Teardown Support for GitHub Actions Workflows #191

🚀[Feature]: Test Setup & Teardown Support for GitHub Actions Workflows #191

Uh oh!

Conversation

MariusStorhaug commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

🎯 Main Feature: Test Lifecycle Management

The Problem

The Solution

Configuration

Additional: Specification-Driven Development Framework

What's Included

Additional Workflow Improvements

Linter Configuration Updates

Test Workflow Enhancements

Documentation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

MariusStorhaug commented Oct 1, 2025 •

edited

Loading